API Documentation
Static Public Member Functions | List of all members
nkAstraeus::lua::nkGraphicsWrap::EntityWrapper Class Referencefinal

Wraps a nkGraphics::Entity and offers functions for use in scripting. More...

Static Public Member Functions

static void updateEnvironment (nkScripts::Environment *env)
 
static nkScripts::OutputValue addChild (const nkScripts::DataStack &stack)
 
static nkScripts::OutputValue removeChild (const nkScripts::DataStack &stack)
 
static nkScripts::OutputValue setShader (const nkScripts::DataStack &stack)
 

Detailed Description

Wraps a nkGraphics::Entity and offers functions for use in scripting.

Member Function Documentation

◆ updateEnvironment()

static void nkAstraeus::lua::nkGraphicsWrap::EntityWrapper::updateEnvironment ( nkScripts::Environment env)
static

Updates a given environment and set it up to use all functions wrapped by this wrapper.

Parameters
envThe environment to set up.

◆ addChild()

static nkScripts::OutputValue nkAstraeus::lua::nkGraphicsWrap::EntityWrapper::addChild ( const nkScripts::DataStack stack)
static

Wrapper function for the nkGraphics::Entity::addChild().

local s = e:addChild() ;
Parameters
stackThe parameter stack.
Returns
The attribute value, as a nkGraphics::SubEntity.

◆ removeChild()

static nkScripts::OutputValue nkAstraeus::lua::nkGraphicsWrap::EntityWrapper::removeChild ( const nkScripts::DataStack stack)
static

Wrapper function for the nkGraphics::Entity::removeChild().

e:removeChild(0) ;
Parameters
stackThe parameter stack.
Returns
The attribute value, empty.

◆ setShader()

static nkScripts::OutputValue nkAstraeus::lua::nkGraphicsWrap::EntityWrapper::setShader ( const nkScripts::DataStack stack)
static

Wrapper function for the nkGraphics::Entity::setShader().

e:setShader(s) ;
Parameters
stackThe parameter stack.
Returns
The attribute value, empty.

The documentation for this class was generated from the following file: